home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / include / bgui / bgui_treeview.h < prev    next >
Encoding:
C/C++ Source or Header  |  2000-05-09  |  11.9 KB  |  399 lines
  1. /*
  2.  * @(#) $Header: /cvsroot/bgui/gadgets/TreeView/include/TreeViewClass.h,v 41.11 2000/05/09 20:36:14 mlemos Exp $
  3.  *
  4.  * BGUI Tree List View class
  5.  *
  6.  * (C) Copyright 1999 Manuel Lemos.
  7.  * (C) Copyright 1996-1999 Nick Christie.
  8.  * All Rights Reserved.
  9.  *
  10.  * $Log: TreeViewClass.h,v $
  11.  * Revision 41.11  2000/05/09 20:36:14  mlemos
  12.  * Bumped to revision 41.11
  13.  *
  14.  * Revision 1.2  2000/05/09 20:01:08  mlemos
  15.  * Merged with the branch Manuel_Lemos_fixes.
  16.  *
  17.  * Revision 1.1.2.1  1999/02/21 04:08:33  mlemos
  18.  * Nick Christie sources.
  19.  *
  20.  *
  21.  *
  22.  */
  23.  
  24. /************************************************************************
  25. ***************************  TREEVIEW CLASS  ****************************
  26. *************************************************************************
  27. *
  28. * NAME
  29. *
  30. * Class:        treeviewclass [private]
  31. * SuperClass:    groupclass [BGUI, public]
  32. *
  33. *
  34. * FUNCTION
  35. *
  36. * This is a BGUI gadget class that can display data with a hierarchical
  37. * or tree-like structure. In general appearance, it looks like a BGUI
  38. * listview, in fact, it currently uses a listview for basic control
  39. * and display purposes.
  40. *
  41. * The name of each member of the tree is displayed appropriately indented,
  42. * with a small box next to it containing a plus sign if the children of
  43. * the member have been expanded, a minus sign if not. By clicking on the
  44. * box, the user can expand or contract the child list.
  45. *
  46. * Like the BGUI listview, the treeview's native datatype for its
  47. * members is a C-style string. However, hooks are provided to allow
  48. * any type of data to be added to the tree.
  49. *
  50. *
  51. * NEW METHODS
  52. *
  53. * 
  54. *
  55. *
  56. * CHANGED METHODS
  57. *
  58. *
  59. *
  60. * ATTRIBUTES
  61. *
  62. * TV_??? -- (ULONG)                (ISG--)
  63. *
  64. *
  65. *
  66. * EXTERNAL REQUIREMENTS
  67. *
  68. * Client must open these libraries: intuition.library V37+,
  69. * utility.library V37+ and bgui.library V40+ and provide their
  70. * base pointers.
  71. *
  72. *
  73. *************************************************************************/
  74.  
  75. /************************************************************************
  76. *************************  PUBLIC DEFINITIONS  **************************
  77. ************************************************************************/
  78.  
  79. /*
  80.  * Tags for class attributes
  81.  */
  82.  
  83. #define TAG_TVA_BASE        TAG_USER+0x12340000
  84.  
  85. #define TVA_ResourceHook    (TAG_TVA_BASE+1)    /* (I----) */
  86. #define TVA_DisplayHook        (TAG_TVA_BASE+2)    /* (I----) */
  87. #define TVA_CompareHook        (TAG_TVA_BASE+3)    /* (I----) */
  88. #define TVA_ExpandHook        (TAG_TVA_BASE+4)    /* (I----) */
  89. #define TVA_ImageStyle        (TAG_TVA_BASE+5)    /* (I----) */
  90. #define TVA_LineStyle        (TAG_TVA_BASE+6)    /* (I----) */
  91. #define TVA_ExpandedImage    (TAG_TVA_BASE+7)    /* (I----) */
  92. #define TVA_ContractedImage    (TAG_TVA_BASE+8)    /* (I----) */
  93. #define TVA_LeftAlignImage    (TAG_TVA_BASE+9)    /* (I----) */
  94. #define TVA_NoLeafImage        (TAG_TVA_BASE+10)    /* (I----) */
  95. #define TVA_CopyEntries        (TAG_TVA_BASE+11)    /* (I----) */
  96. #define TVA_Entry            (TAG_TVA_BASE+20)    /* (---N-) */
  97. #define TVA_Parent            (TAG_TVA_BASE+21)    /* (---N-) */
  98. #define TVA_Moved            (TAG_TVA_BASE+22)    /* (---N-) */
  99. #define TVA_NumEntries        (TAG_TVA_BASE+30)    /* (--G--) */
  100. #define TVA_LastClicked        (TAG_TVA_BASE+31)    /* (--G--) */
  101. #define TVA_ViewBounds        (TAG_TVA_BASE+32)    /* (--G--) */
  102. #define TVA_Indentation        (TAG_TVA_BASE+40)    /* (ISG--) */
  103. #define TVA_Top                (TAG_TVA_BASE+41)    /* (-SG--) */
  104.  
  105. /*
  106.  * Tags for class methods
  107.  */
  108.  
  109. #define TAG_TVM_BASE        TAG_TVA_BASE+512
  110.  
  111. #define TVM_INSERT            (TAG_TVM_BASE+1)
  112. #define TVM_REMOVE            (TAG_TVM_BASE+2)
  113. #define TVM_REPLACE            (TAG_TVM_BASE+3)
  114. #define TVM_MOVE            (TAG_TVM_BASE+4)
  115. #define TVM_GETENTRY        (TAG_TVM_BASE+5)
  116. #define TVM_SELECT            (TAG_TVM_BASE+6)
  117. #define TVM_VISIBLE            (TAG_TVM_BASE+7)
  118. #define TVM_EXPAND            (TAG_TVM_BASE+8)
  119. #define TVM_CLEAR            (TAG_TVM_BASE+9)
  120. #define TVM_LOCK            (TAG_TVM_BASE+10)
  121. #define TVM_UNLOCK            (TAG_TVM_BASE+11)
  122. #define TVM_SORT            (TAG_TVM_BASE+12)
  123. #define TVM_REDRAW            (TAG_TVM_BASE+13)
  124. #define TVM_REFRESH            (TAG_TVM_BASE+14)
  125. #define TVM_REBUILD            (TAG_TVM_BASE+15)        /* debug only! */
  126.  
  127. /*
  128.  * Values for TVA_ImageStyle:
  129.  */
  130.  
  131. #define TVIS_BOX            0
  132. #define TVIS_ARROW            1
  133.  
  134. /*
  135.  * Values for TVA_LineStyle:
  136.  */
  137.  
  138. #define TVLS_NONE            0
  139. #define TVLS_DOTS            1
  140. #define TVLS_DASH            2
  141. #define TVLS_SOLID            3
  142.  
  143. /*
  144.  * Message structure for TVM_INSERT, TVM_MOVE:
  145.  */
  146.  
  147. struct tvInsert {
  148.     ULONG                tvi_MethodID;    /* TVM_INSERT, TVM_MOVE */
  149.     struct GadgetInfo    *tvi_GInfo;        /* GadgetInfo */
  150.     APTR                tvi_Entry;        /* entry to insert or move */
  151.     APTR                tvi_Relation;    /* parent or sibling entry */
  152.     ULONG                tvi_Where;        /* see below */
  153.     ULONG                tvi_Flags;        /* see below */
  154. };
  155.  
  156. /*
  157.  * Message structure for TVM_REPLACE
  158.  */
  159.  
  160. struct tvReplace {
  161.     ULONG                tvr_MethodID;    /* TVM_REPLACE */
  162.     struct GadgetInfo    *tvr_GInfo;        /* GadgetInfo */
  163.     APTR                tvr_NewEntry;    /* entry to replace with */
  164.     APTR                tvr_OldEntry;    /* entry to replace */
  165.     ULONG                tvr_Where;        /* see below */
  166.     ULONG                tvr_Flags;        /* see below */
  167. };
  168.  
  169. /*
  170.  * Message structure for TVM_GETENTRY:
  171.  */
  172.  
  173. struct tvGet {
  174.     ULONG                tvg_MethodID;    /* TVM_GET */
  175.     APTR                tvg_Entry;        /* parent or sibling, etc */
  176.     ULONG                tvg_Which;        /* see below */
  177.     ULONG                tvg_Flags;        /* see below */
  178. };
  179.  
  180. /*
  181.  * Message structure for TVM_REMOVE, TVM_SELECT,
  182.  * TVM_VISIBLE, TVM_EXPAND:
  183.  */
  184.  
  185. struct tvEntry {
  186.     ULONG                tve_MethodID;    /* TVM_REMOVE, etc */
  187.     struct GadgetInfo    *tve_GInfo;        /* GadgetInfo */
  188.     APTR                tve_Entry;        /* entry, parent or sibling, etc */
  189.     ULONG                tve_Which;        /* see below */
  190.     ULONG                tve_Flags;        /* see below */
  191. };
  192.  
  193. /*
  194.  * Message structure for TVM_LOCK consists of only the MethodID.
  195.  */
  196.  
  197. /*
  198.  * Message structure for TVM_SORT, TVM_REDRAW, TVM_REFRESH,
  199.  * TVM_CLEAR and TVM_UNLOCK:
  200.  */
  201.  
  202. struct tvCommand {
  203.     ULONG                tvc_MethodID;    /* method ID value */
  204.     struct GadgetInfo    *tvc_GInfo;        /* GadgetInfo */
  205. };
  206.  
  207. /*
  208.  * Special values for any pointer to an existing entry:
  209.  */
  210.  
  211. #define TV_ROOT            ((APTR) 0L)        /* dummy root entry */
  212. #define TV_SELECTED        ((APTR) 1L)        /* first selected entry */
  213.  
  214. /*
  215.  * For internal use only
  216.  */
  217.  
  218. #define TVWC_ENTRY            (0L<<16)
  219. #define TVWC_PARENT            (1L<<16)
  220. #define TVWC_CHILD            (2L<<16)
  221. #define TVWC_SIB            (3L<<16)
  222. #define TVWC_TREE            (4L<<16)
  223. #define TVWC_MASK            (7L<<16)
  224.  
  225. #define TVWS_FIRST            1
  226. #define TVWS_LAST            2
  227. #define TVWS_NEXT            3
  228. #define TVWS_PREV            4
  229. #define TVWS_PGUP            5
  230. #define TVWS_PGDN            6
  231. #define TVWS_SORT            7
  232. #define TVWS_ALL            8
  233. #define TVWS_TREE            9
  234. #define TVWS_MASK            15
  235.  
  236. /*
  237.  * Values for tv?_Which and tv?_Where:
  238.  *
  239.  * Key: I = insert, R = remove, P = replace, M = move, G = get,
  240.  *        S = select, V = visible, E = expand
  241.  */
  242.  
  243. #define TVW_ENTRY            (TVWC_ENTRY)            /* specified entry only (R,P,G,S,V,E) */
  244. #define TVW_PARENT            (TVWC_PARENT)            /* parent of entry (R,P,G,S,V,E) */
  245. #define TVW_CHILD_FIRST        (TVWC_CHILD|TVWS_FIRST)    /* first child of entry (I,R,P,M,G,S,V,E) */
  246. #define TVW_CHILD_LAST        (TVWC_CHILD|TVWS_LAST)    /* last child of entry (I,R,P,M,G,S,V,E) */
  247. #define TVW_CHILD_SORTED    (TVWC_CHILD|TVWS_SORT)    /* child of entry, sorted (I,P,M) */
  248. #define TVW_CHILD_ALL        (TVWC_CHILD|TVWS_ALL)    /* all children of entry (R,P,S,E) */
  249. #define TVW_CHILD_TREE        (TVWC_CHILD|TVWS_TREE)    /* all children, recursively (S,E) */
  250. #define TVW_SIBLING_FIRST    (TVWC_SIB|TVWS_FIRST)    /* first sibling of entry (I,R,P,M,G,S,V,E) */
  251. #define TVW_SIBLING_LAST    (TVWC_SIB|TVWS_LAST)    /* last sibling of entry (I,R,P,M,G,S,V,E) */
  252. #define TVW_SIBLING_NEXT    (TVWC_SIB|TVWS_NEXT)    /* next sibling of entry (I,R,P,M,G,S,V,E) */
  253. #define TVW_SIBLING_PREV    (TVWC_SIB|TVWS_PREV)    /* prev. sibling of entry (I,R,P,M,G,S,V,E) */
  254. #define TVW_SIBLING_SORTED    (TVWC_SIB|TVWS_SORT)    /* sibling of entry, sorted (I,P,M) */
  255. #define TVW_SIBLING_ALL        (TVWC_SIB|TVWS_ALL)        /* entry and all siblings (R,P,S,E) */
  256. #define TVW_SIBLING_TREE    (TVWC_SIB|TVWS_TREE)    /* entry, siblings and all children recursively (S,E) */
  257. #define TVW_TREE_FIRST        (TVWC_TREE|TVWS_FIRST)    /* first in tree, entry ignored (R,G,S,V,E) */
  258. #define TVW_TREE_LAST        (TVWC_TREE|TVWS_LAST)    /* last in tree, entry ignored (R,G,S,V,E) */
  259. #define TVW_TREE_NEXT        (TVWC_TREE|TVWS_NEXT)    /* next in tree from entry (R,G,S,V,E) */
  260. #define TVW_TREE_PREV        (TVWC_TREE|TVWS_PREV)    /* prev. in tree from entry (R,G,S,V,E) */
  261. #define TVW_TREE_PAGE_UP    (TVWC_TREE|TVWS_PGDN)    /* page up in tree from entry (G,S,V,E) */
  262. #define TVW_TREE_PAGE_DOWN    (TVWC_TREE|TVWS_PGUP)    /* page down in tree from entry (G,S,V,E) */
  263.  
  264. /*
  265.  * Bits for tv?_Flags:
  266.  */
  267.  
  268. #define TVF_ALL                0L            /* dummy flag for all entries */
  269. #define TVF_SELECTED        (1L<<0)        /* affect only selected entries (R,P,G,V,E) */
  270. #define TVF_VISIBLE            (1L<<1)        /* affect only visible entries (R,P,G,E) */
  271.  
  272. #define TVF_SELECT            (1L<<8)        /* select entry (I,P,M,V,E) */
  273. #define TVF_DESELECT        (1L<<9)        /* deselect entry (P,M,S,V,E) */
  274. #define TVF_MULTISELECT        (1L<<10)    /* multi-select entry (with TVF_SELECT) */
  275. #define TVF_MAKEVISIBLE        (1L<<11)    /* make entry visible (I,P,M,S,E) */
  276. #define TVF_EXPAND            (1L<<12)    /* expand entry (I,P,M,S,V) */
  277. #define TVF_CONTRACT        (1L<<13)    /* contract entry (P,M,S,V,E) */
  278. #define TVF_TOGGLE            (1L<<14)    /* toggle selection/expansion (S,E) */
  279.  
  280. #define TVF_USER_ACTION        (1L<<30)    /* private */
  281. #define TVF_INTERNAL        (1L<<31)    /* private */
  282.  
  283. /*
  284.  * The TV_ResourceHook is called as follows:
  285.  *
  286.  * rc = hookFunc( REG(A0) struct Hook *hook,
  287.  *                  REG(A2) Object *tv_object,
  288.  *                  REG(A1) struct tvResource *message );
  289.  *
  290.  * On make, return a pointer to the entry to be added, or NULL.
  291.  * On kill, return 0.
  292.  */
  293.  
  294. struct tvResource {
  295.     UWORD            tvr_Command;        /* whether to make or kill */
  296.     APTR            tvr_Entry;            /* entry to be added or removed */
  297. };
  298.  
  299. /*
  300.  * TV_ResourceHook commands in tvr_Command
  301.  */
  302.  
  303. #define TVRC_MAKE        1                /* Build the entry. */
  304. #define TVRC_KILL        2                /* Kill the entry.  */
  305.  
  306. /*
  307.  * The TV_DisplayHook is called as follows:
  308.  *
  309.  * rc = hookFunc( REG(A0) struct Hook *hook,
  310.  *                  REG(A2) Object *tv_object,
  311.  *                  REG(A1) struct tvRender *message );
  312.  *
  313.  * If your hook completes all rendering, return 0. If you wish
  314.  * the treeview to render a string, return the string, which
  315.  * may have BGUI-style formatting sequences embedded in it.
  316.  */
  317.  
  318. struct tvRender {
  319.     struct RastPort *tvr_RPort;            /* rastport to render in */
  320.     struct DrawInfo *tvr_DrawInfo;        /* all you need to render */
  321.     struct Rectangle tvr_Bounds;        /* bounds to render in */
  322.     APTR            tvr_Entry;            /* entry to render */
  323.     UWORD            tvr_State;            /* see below */
  324.     UWORD            tvr_Flags;            /* see below */
  325. };
  326.  
  327. /*
  328.  * Rendering states in lvr_State
  329.  */
  330.  
  331. #define TVRS_NORMAL                0        /* normal, enabled state */
  332. #define TVRS_SELECTED            1        /* selected and enabled */
  333. #define TVRS_NORMAL_DISABLED    2        /* normal disabled state */
  334. #define TVRS_SELECTED_DISABLED    3        /* selected and disabled */
  335.  
  336. /*
  337.  * Flag bits in lvr_Flags
  338.  */
  339.  
  340. #define TVRF_EXPANDED        (1L<<0)        /* entry is expanded */
  341.  
  342. /*
  343.  * The TV_CompareHook is called as follows:
  344.  *
  345.  * rc = hookFunc( REG(A0) struct Hook *hook,
  346.  *                  REG(A2) Object *tv_object,
  347.  *                  REG(A1) struct tvCompare *message );
  348.  *
  349.  * Your hook must return -1 when entry A should come before entry B, 0 when
  350.  * entry A is equal to entry B and 1 when entry A should come after entry B.
  351.  */
  352.  
  353. struct tvCompare {
  354.     APTR            tvc_EntryA;            /* first entry */
  355.     APTR            tvc_EntryB;            /* second entry */
  356. };
  357.  
  358. /*
  359.  * The TV_ExpandHook is called as follows:
  360.  *
  361.  * rc = hookFunc( REG(A0) struct Hook *hook,
  362.  *                  REG(A2) Object *tv_object,
  363.  *                  REG(A1) struct tvExpand *message );
  364.  *
  365.  * Your hook should return non-zero if the expansion or contraction
  366.  * is to go ahead, zero if it should be cancelled.
  367.  *
  368.  * Important: Your hook may *not* invoke any methods on the treeview.
  369.  */
  370.  
  371. struct tvExpand {
  372.     UWORD            tve_Command;        /* whether to expand or contract */
  373.     APTR            tve_Entry;            /* entry to be expanded/contracted */
  374.     ULONG            tve_Flags;            /* see below */
  375. };
  376.  
  377. /*
  378.  * tvExpand commands in tve_Command
  379.  */
  380.  
  381. #define TVEC_EXPAND            1            /* entry is to be expanded */
  382. #define TVEC_CONTRACT        2            /* entry is to be contracted */
  383.  
  384. /*
  385.  * Flag bits in tve_Flags
  386.  */
  387.  
  388. #define TVEF_USER_ACTION    (1L<<0)        /* hook called due to user action */
  389.  
  390. /************************************************************************
  391. **************************  PUBLIC PROTOTYPES  **************************
  392. ************************************************************************/
  393.  
  394. Class *MakeTreeViewClass(void);
  395.  
  396. BOOL FreeTreeViewClass(Class *cl);
  397.  
  398.  
  399.